aviator

2024-01-04 04:50| 来源: 网络整理| 查看: 265

Maintainability Rating Security Rating Vulnerabilities Duplicated Lines (%) Bugs Code Smells Lines of Code

aviator-rule-engine

一个基于AviatorScript的简单规则引擎实例。将规则划分为规则集、规则、条件三个维度，可以满足业务规则的通用性配置，同时也可以进行扩展。

此项目同时包含完整的后台管理页面（使用Next.js + Material UI开发），也可自行替换。

快速使用示例入口快速使用说明入口快速查看接口文档依赖版本 AviatorScript 5.3.3 SpringBoot 2.3.8.RELEASE 创建数据表条件(t_condition_info) CREATE TABLE `t_condition_info` ( `id` bigint unsigned NOT NULL AUTO_INCREMENT, `rule_id` bigint unsigned NOT NULL COMMENT '所属规则id', `name` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL COMMENT '条件名称', `remark` varchar(128) DEFAULT NULL COMMENT '条件备注', `variable_name` varchar(32) NOT NULL COMMENT '变量名（作为参数传入的唯一标识符）', `reference_value` varchar(256) NOT NULL COMMENT '参考值', `relation_type` varchar(32) NOT NULL COMMENT '条件关系运算类型', `logic_type` varchar(32) NOT NULL COMMENT '条件逻辑运算类型', `priority` smallint unsigned NOT NULL COMMENT '条件优先级（值越大优先级越高）', PRIMARY KEY (`id`), KEY `ix_rule_id` (`rule_id`) ) ENGINE = InnoDB AUTO_INCREMENT = 1 DEFAULT CHARSET = utf8mb4 COMMENT = '条件'; 规则(t_rule_info) CREATE TABLE `t_rule_info` ( `id` bigint unsigned NOT NULL AUTO_INCREMENT, `ruleset_id` bigint NOT NULL COMMENT '所属规则集ID', `name` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL COMMENT '规则名称', `remark` varchar(128) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '规则备注', `return_values` varchar(256) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL COMMENT '返回值集合', `logic_type` varchar(32) NOT NULL COMMENT '规则逻辑运算类型', `priority` smallint unsigned NOT NULL COMMENT '规则优先级（值越大优先级越高）', PRIMARY KEY (`id`), KEY `ix_ruleset_id` (`ruleset_id`) USING BTREE ) ENGINE = InnoDB AUTO_INCREMENT = 1 DEFAULT CHARSET = utf8mb4 COMMENT = '规则'; 规则集(t_ruleset_info) CREATE TABLE `t_ruleset_info` ( `id` bigint NOT NULL AUTO_INCREMENT, `code` varchar(20) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL COMMENT '规则集编码', `name` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL COMMENT '规则集名称', `remark` varchar(128) DEFAULT NULL COMMENT '规则集备注', `default_return_values` varchar(256) DEFAULT NULL COMMENT '默认返回值集合', `expression` varchar(1024) DEFAULT NULL COMMENT '规则集表达式', `mode` tinyint NOT NULL DEFAULT '0' COMMENT '模式（0：创建中 1：已创建）', PRIMARY KEY (`id`), KEY `ix_code` (`code`) USING BTREE ) ENGINE = InnoDB AUTO_INCREMENT = 1 DEFAULT CHARSET = utf8mb4 COMMENT = '规则集'; 支持的条件逻辑运算类型

ConditionLogicType

逻辑类型值描述 AND && 如果当前条件单元为真，则继续向后执行，否则跳过后面的条件单元，直接返回假 OR || 如果当前条件单元为真，则跳过后面的条件单元直接返回真，否则继续向后执行支持的条件关系运算类型

ConditionRelationType

关系类型条件条件类型描述 EQUAL 等于（=） NOT_EQUAL 不等于（!=） LESS_EQUAL 小于等于（=） LESS 小于（）集合类型条件条件类型描述 INCLUDE_IN_LIST 列表包含指定字符串 NOT_INCLUDE_IN_LIST 列表不包含指定字符串 SOME_CONTAINS_IN_LIST 列表包含指定字符串的某一部分 NONE_CONTAINS_IN_LIST 列表不包含指定字符串的任何部分

提示: 列表作为参考值(referenceValue)传入时，多个元素之间以逗号(,)进行分隔。

例如：1,2,3，字符1,字符2,字符3。

字符类型条件条件类型描述 STRING_CONTAINS 包含指定字符 STRING_NOT_CONTAINS 不包含指定字符 STRING_STARTSWITH 以指定字符开始 STRING_NOT_STARTSWITH 不以指定字符开始 STRING_ENDSWITH 以指定字符结束 STRING_NOT_ENDSWITH 不以指定字符结束区间类型条件条件类型描述 INTERVAL_NUMBER 数值区间 INTERVAL_STRING_LENGTH 字符长度区间

提示: 区间作为参考值(referenceValue)传入时，和数学中的区间表示形式和含义相同。

例如：[1,10]是闭区间，表示：x >= 1 && x 1 && x < 10；[1,10)是左闭右开区间，表示：x >= 1 && x < 10；(1,10]是左开右闭区间，表示：x > 1 && x = 99。

多个条件可以按照关系运算类型、逻辑运算类型组合成一个规则。例如：x >= 99 || y < 45。

当然单个条件本身也是一个规则，可以认为x >= 99等同于x >= 99 && true。

条件优先级

条件优先级决定了条件之间的组合次序和执行顺序。同一个规则下所有条件按优先级进行排序，优先级越高，组合次序和执行顺序越靠前。（同一规则下，不能存在优先级相同的条件，保证执行顺序唯一。）

例如，定义一个规则下的条件表达式及优先级如下：

条件表达式条件逻辑运算符条件优先级 x == 1 || 8 y > 2 && 4 z 2) && z 2) && z 2。条件y > 2逻辑运算类型为&&，由于和左侧条件x == 1进行组合，所以作用于右侧条件z 2) && z 2) && z = 99，x是条件的变量名，作为参数传入的唯一标识符，>=是条件的关系运算符（对应的关系运算类型为，ConditionRelationType.EQUAL），99是条件的参考值，用于和以x为变量名的参数值进行对应的关系运算。

规则

多个条件经过组合之后就是一个规则，一个规则下附带一个条件列表，在生成规则表达式时，条件列表中的所有条件将按优先级从高到低进行组合。

规则优先级

规则优先级的含义和条件优先级相似。规则优先级决定了多个规则之间的组合顺序和结构。

规则逻辑运算

每条规则都附带逻辑运算类型，以两个规则的组合为例，规则逻辑运算的作用机制说明如下：

若高优先级规则的逻辑运算类型为关联类型（AND），则高优先级规则的逻辑运算作用于低优先级规则，低优先级规则的逻辑运算不影响规则组合，但低优先级规则设置的返回值集合即为规则组合的返回值集合（高优先级规则设置的返回值集合被覆盖）；若高优先级规则的逻辑运算类型为互斥类型（XOR），则高优先级规则和低优先级规则的逻辑运算互不影响，返回值集合也不会被任何一方覆盖；

以如下表达式为例：

(a == 1|| b == 2) && (c == 3 || d == 4)

从表面上看，这是一个规则表达式，将其拆分为4个条件（最小执行单元）后分别为a == 1、b ==2、c ==3、d ==4，同一规则下的多个条件组合时按照优先级从高到低进行组合，组合顺序是唯一的。但结合表达式来看，此处的表达式出现了两个组合顺序，即：(a == 1|| b == 2)和(c == 3 || d == 4)，因此不能作为一条规则进行组合。

我们将其作为两个规则(R1,R2)进行组合，这两条规则下的条件列表分别为a == 1、b ==2和c ==3、d ==4，对应的两个规则表达式为R1:a == 1|| b == 2，R2:c == 3 || d == 4。

其中R1优先级设置为100，逻辑运算类型设置为关联类型（AND），返回值集合和R2相同即可（R1在两个规则的组合之间优先级最高，返回值集合被R2覆盖）；

R2优先级设置为98，逻辑运算类型为AND和XOR均可（R2在两个规则的组合之间优先级最低，逻辑运算不作用于其他任何规则），返回值集合设置为：{'myvariable':true}。

将R1、R2添加到一个规则集下，最终生成表达式为(a == 1|| b == 2) && (c == 3 || d == 4)，对应生成的aviator执行脚本为：

let rmap = seq.map('myvariable', false); if((a == 1 || b == 2) && (c == 3 || d == 4)){ seq.put(rmap, 'myvariable', true); } return rmap; 规则集

规则集是规则引擎执行的对象，一个规则集下包含一个或多个规则，默认添加的规则集处于RulesetMode.BUILDING模式，表示当前的规则集表达式未生成，规则集处于不可用状态。当规则集下存在规则，并且每个规则下存在条件时，规则集自动切换为RulesetMode.BUILT模式，并且生成规则集表达式。

规则集设置默认返回值集合

规则集支持设置默认返回值。在设置规则时，可以设置当前规则匹配时的返回值，对于规则集下所有规则均不匹配的情况，可以在规则集设置默认返回值defaultReturnValues，数据格式和在规则下设置返回值集合相同（e.g. {'returnVariable1':returnValue1,'returnVariable2':returnValue2}）。

使用示例一个计算费用、费率的简单示例

如下为一个产品费率计算规则：

年龄（AGE）额度（AMT）费用（PREM）费率（RATE）‰ 0~3岁 1000000 67.9 0.0679 4~11岁 1000000 198.2 0.1982 12岁 1000000 18 0.018

需要按上述规则，通过年龄、额度来动态计算0~12岁的儿童产品的费用和费率。

规则集是规则引擎执行的对象，因此首先创建一个规则集，在规则集添加三条规则，在每个规则中配置对应的条件，具体的过程如下：

创建规则集

指定规则集编码为RULEST_RATE_CALC，参数如下：

{ "code": "RULEST_RATE_CALC", "name": "ruleset for rate calculate", "defaultReturnValues": "{PREM:0.00,RATE:0.00}" }

其中code是规则集编码，用于标识一个规则集，必须唯一且不可重复。name是这个规则集的名称。defaultReturnValues是这个规则集定义的默认返回值集合，如果规则集下面的规则都不匹配，那么规则引擎执行当前规则集的返回结果就是其默认返回值集合。

返回值集合的格式是一个map集合的json字符串。

返回值集合的含义就是规则引擎接口返回的对应的map集合。如果上述规则集下所有规则都不匹配，那么规则引擎最终返回的结果就是：

{ "PREM": 0.00, "RATE": 0.00 }

通过返回值集合中定义的返回值变量名PREM和RATE，可以从map集合中获取对应的返回值。

在当前规则集下添加规则

在当前例子中，需要添加三组规则，参数如下：

{ "rulesetId": 2, "name": "rule for age(0-3)", "returnValues": "{PREM:67.9,RATE:0.0679}", "logicType": "XOR", "priority": 100 } { "rulesetId": 2, "name": "rule for age(4-11)", "returnValues": "{PREM:198.2,RATE:0.1982}", "logicType": "XOR", "priority": 99 } { "rulesetId": 2, "name": "rule for age(12)", "returnValues": "{PREM:18,RATE:0.018}", "logicType": "XOR", "priority": 98 }

其中rulesetId是当前规则所属规则集的主键id，name是规则的名称，returnValues是为当前规则匹配时定义的返回值集合，logicType是规则逻辑运算类型，priority是规则的优先级。

在每个对应规则下添加条件

rule for age(0-3)

[ { "ruleId": 2, "name": "children age 0~3", "variableName": "AGE", "referenceValue": "[0,3]", "relationType": "INTERVAL_NUMBER", "logicType": "AND", "priority": 10 }, { "ruleId": 2, "name": "amount total", "variableName": "AMT", "referenceValue": "1000000", "relationType": "EQUAL", "logicType": "AND", "priority": 8 } ]

rule for age(4-11)

[ { "ruleId": 4, "name": "children age 4~11", "variableName": "AGE", "referenceValue": "[4,11]", "relationType": "INTERVAL_NUMBER", "logicType": "AND", "priority": 10 }, { "ruleId": 4, "name": "amount total", "variableName": "AMT", "referenceValue": "1000000", "relationType": "EQUAL", "logicType": "AND", "priority": 8 } ]

rule for age(12)

[ { "ruleId": 5, "name": "children age", "variableName": "AGE", "referenceValue": "12", "relationType": "EQUAL", "logicType": "AND", "priority": 10 }, { "ruleId": 5, "name": "amount total", "variableName": "AMT", "referenceValue": "1000000", "relationType": "EQUAL", "logicType": "AND", "priority": 9 } ]

ruleId是当前条件所属规则的主键id，name为条件名称，variableName和referenceValue分别为变量名和参考值，变量名的含义是在调用规则引擎接口时，用于接收外部参数的变量名称，参考值的作用是和变量名所代表的参数值进行比较。relationType用于定义变量名和参考值之间的关系运算类型。logicType表示条件之间的逻辑运算类型。priority表示条件优先级。

生成规则表达式

添加规则集、规则、条件之后，自动生成规则集表达式如下：

let rmap = seq.map(); if((AGE >= 0 && AGE = 4 && AGE

【本文地址】

公司简介

联系我们